Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC-2761 Geospatial reference information #979

Merged
merged 7 commits into from
Jan 15, 2025

Conversation

andy-stark-redis
Copy link
Contributor

@andy-stark-redis andy-stark-redis commented Dec 12, 2024

DOC-2761

This adds a new geo reference page (based mainly on the information here), and also adds missing info about GEOSHAPE to the indexing and schema type info.

A few things to note:

  • This breaks the indexing info out of the main indexing page into a geo-specific page. The main indexing page is huge, so I think it should be split into separate pages like this, but doing this for all existing schema types is a job for a separate PR.
  • The new geo indexing page will have code samples but I figured it was best to get the text reviewed rather than wait for them all to be approved and merged.
  • The JIRA ticket requests both current and planned features, but AFAIK, we don't normally document features until they are available in the product, so I've left these out.

All feedback about content, approach, missing bits, etc, is welcome :-)

@andy-stark-redis andy-stark-redis self-assigned this Dec 12, 2024
Copy link
Collaborator

@dwdougherty dwdougherty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@andy-stark-redis: this is really good. Just a couple of minor things that need tweaking.

@andy-stark-redis
Copy link
Contributor Author

@dwdougherty Thanks for catching those! I just copied the Redis Stack link from somewhere else without thinking :-(

Copy link
Collaborator

@dwdougherty dwdougherty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving now, but I still think it needs to be reviewed by Adriano and Joey

@joeywhelan
Copy link
Contributor

@andy-stark-redis
Copy link
Contributor Author

This is a dead link, but otherwise really good.

https://redis.io/docs/staging/DOC-2761-geo-ref-page/develop/interact/search-and-query/indexing/geo/

@joeywhelan It's actually https://redis.io/docs/staging/DOC-2761-geo-ref-page/develop/interact/search-and-query/indexing/geoindex/

The link was auto-generated by the build system - I think I used just "geo" for the filename originally but changed it later. Did you find the page it was supposed to link to?

@andy-stark-redis andy-stark-redis merged commit 32314a0 into main Jan 15, 2025
5 checks passed
@andy-stark-redis andy-stark-redis deleted the DOC-2761-geo-ref-page branch January 15, 2025 12:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants